{"componentChunkName":"component---src-templates-post-jsx","path":"/[OpenSW]2.GCP배포와SpringRESTDocs적용/","result":{"data":{"site":{"siteMetadata":{"title":"SUbbb"}},"markdownRemark":{"id":"e995a783-d49d-5bbf-8006-2417ec33eedb","excerpt":"⚽️ 배포 이전 글에서 다루었듯, GCP 환경에서 lighthouse 기능을 사용할 수 있었다. 따라서 스프링 부트 배포 또한 GCP 환경에 수행해야 했다. 이전에 몇 번 서버 배포 시에는, AWS를 사용했어서 꽤나 능숙하게 배포할 수 있었지만 이번엔 처음으로 GCP를 사용해서 엄청 많이 헤맸다 ... 아래의 참고 사이트들을 통해 해결할 수 있었고, 전체적…","html":"<h2>⚽️ 배포</h2>\n<p>이전 글에서 다루었듯, GCP 환경에서 lighthouse 기능을 사용할 수 있었다. 따라서 스프링 부트 배포 또한 GCP 환경에 수행해야 했다.</p>\n<p>이전에 몇 번 서버 배포 시에는, AWS를 사용했어서 꽤나 능숙하게 배포할 수 있었지만 이번엔 처음으로 GCP를 사용해서 엄청 많이 헤맸다 ...</p>\n<p>아래의 참고 사이트들을 통해 해결할 수 있었고, 전체적인 틀은 거의 유사했다.</p>\n<ul>\n<li>다만, ssh을 브라우저를 통해 연결할 수 있었고</li>\n<li>프로젝트 빌드 후 만들어진 jar 파일을 브라우저 ssh에서 다운받아 구동할 수 있다는 점이 달랐다.</li>\n</ul>\n<blockquote>\n<p>이전 AWS를 사용했을 때는 ssh에서 프로젝트 깃 주소를 clone 받아 직접 빌드하고 동작시켰었다.</p>\n</blockquote>\n<p>어찌저찌 인스턴스를 만들고 SQL도 생성하여, 아직까지는 아무것도 만들어지지 않은 프로젝트를 빌드하여 jar 파일을 동작시켰고, 정상적으로 작동하는 것을 확인했다.</p>\n<blockquote>\n<p>다만, 아직 mysql이 제대로 연결되었는지는 잘 모르겠다 ... 일단 IntelliJ에서 Database 연결은 되었으나, 추후 DB 접근 로직을 구현한 후 다시 확인해야 할 것 같다.</p>\n</blockquote>\n<hr>\n<h2>⚽️ Spring REST Docs 적용</h2>\n<p>아직 설계과정이 더 구체화되어야 하기에, 우선 <strong>사용할 API를 정의</strong>하고, <strong>간단한 반환</strong>을 하도록 구현했다. </p>\n<p>사실 이를 한 이유는 <strong>Spring REST docs</strong>를 적용할 것이기 때문이다. 간단하게 코드를 구현해두고, 이에 대한 테스트 코드를 작성해 Spring REST docs를 적용해 프론트엔드단에서 개발 시 참고할 문서를 빠르게 만들 것이다.</p>\n<p>이전에는 <strong>Swagger ui</strong>를 사용했었는데, 사실 <strong>Spring REST docs</strong>라는 것이 있는지 몰랐다는 이유가 컸다. Spring REST docs가 적용이 어렵다는 단점이 있긴 하지만, 최근 테스트 코드를 잘 작성하는 개발자가 되고자 하는 생각을 가지며, 앞으로의 프로젝트에서는 무조건 테스트 코드를 작성하자! 라는 결심을 했기에 테스트 코드 작성을 강제화하는 Spring REST docs를 사용해보고자 했다.</p>\n<p>이제 테스트 코드를 작성하려는데, 처음 보는 <strong>Spring MockMvc</strong>를 사용해 테스트 코드를 작성해야 한다고 한다. 참고를 확인하니, \"Spring REST Docs는 Spring MVC의 테스트 프레임 워크 또는 Rest Assured 3로 작성된 테스트 코드에서 생성된 Snippet을 사용한다.\" 라는 이유가 있었다.</p>\n<blockquote>\n<p>그렇다면, Rest Assured 3를 사용하는 테스트 코드 작성이 아니라 왜 Spring MockMvc를 사용할까?</p>\n</blockquote>\n<p><strong>MockMvc</strong>는 브라우저에서의 요청과 응답을 의미하는 객체로 Controller 테스트를 용이하게 해주는 라이브러리로 <strong>Controller 레이어만 테스트</strong>하기에 속도가 빠르지만, <strong>Rest Assured</strong>의 경우 <strong>전체 컨텍스트를 로드하고 빈을 주입</strong>하기 때문에 속도가 느리다.</p>\n<p>이러한 이유로 인해 Spring MockMvc를 많이 사용하는 것 같다!</p>\n<h3>🏓 MockMvc</h3>\n<p>웹 어플리케이션을 애플리케이션 서버에 배포하지 않고 테스트용 MVC 환경을 만들어 요청 및 전송, 응답기능을 제공해주는 유틸리티 클래스로, 컨트롤러를 테스트하고 싶을 때 실제 서버에 애플리케이션을 동작시키는 것이 아니라, 가짜 시뮬레이션을 통해 MVC가 되도록 도와주는 클래스이다.</p>\n<deckgo-highlight-code language=\"java\" terminal=\"carbon\" theme=\"a11y-dark\" line-numbers=\"true\"  >\n          <code slot=\"code\">package com.example.QCA.QualityControlAutomation.home;\n\nimport static org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders.get;\nimport static org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders.post;\nimport static org.springframework.restdocs.payload.PayloadDocumentation.fieldWithPath;\nimport static org.springframework.restdocs.payload.PayloadDocumentation.responseFields;\nimport static org.springframework.restdocs.request.RequestDocumentation.parameterWithName;\nimport static org.springframework.restdocs.request.RequestDocumentation.pathParameters;\nimport static org.springframework.test.web.servlet.result.MockMvcResultHandlers.print;\nimport static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;\n\n@WebMvcTest\n@AutoConfigureMockMvc\n// Spring REST docs 자동 설정을 위함\n@AutoConfigureRestDocs\nclass HomeControllerTest {\n\n    // MockMvc 객체 생성\n    @Autowired\n    private MockMvc mockMvc;\n\n    @Autowired\n    private ObjectMapper objectMapper;\n\n    @DisplayName(&quot;Top 5 리스트 반환 테스트&quot;)\n    @Test\n    void listTest() throws Exception {\n        mockMvc.perform(\n                // 요청에 대한 정보 입력\n                get(&quot;/api/list&quot;)\n                        .contentType(MediaType.APPLICATION_JSON)\n        )\n                // 응답이 ok인지 테스트\n                .andExpect(status().isOk())\n                // 응답이 JSON인지 테스트\n                .andExpect(content().contentType(MediaType.APPLICATION_JSON))\n                .andDo(\n                        // 어느 디렉토리에 저장할 것인지 명시\n                        document(\n                                &quot;list-get&quot;,\n\n                            responseFields(\n                                    fieldWithPath(&quot;status&quot;).description(&quot;상태 코드&quot;),\n                                    fieldWithPath(&quot;message&quot;).description(&quot;반환 메세지&quot;),\n                                    fieldWithPath(&quot;data&quot;).type(JsonFieldType.ARRAY).description(&quot;결과&quot;),\n                                    fieldWithPath(&quot;data[].label&quot;).type(JsonFieldType.STRING).description(&quot;웹사이트 명&quot;),\n                                    fieldWithPath(&quot;data[].homepage&quot;).type(JsonFieldType.STRING).description(&quot;웹사이트 주소&quot;),\n                                    fieldWithPath(&quot;data[].totalScore&quot;).type(JsonFieldType.NUMBER).description(&quot;웹사이트의 결과 총합&quot;)\n                                )\n                    )\n                )\n        ;\n    }\n}</code>\n        </deckgo-highlight-code>\n<ol>\n<li><code class=\"language-text\">MockMvc</code> 객체를 생성한다. </li>\n<li><code class=\"language-text\">MockMvc</code> 객체에 요청에 대한 정보를 전달한다.</li>\n<li>\n<p>응답값을 <code class=\"language-text\">.andExpect()</code> 를 통해 검증한다.</p>\n<ol>\n<li><code class=\"language-text\">.andExpect()</code> 는 여러 개가 올 수 있고, 모두 통과한다면 테스트 통과</li>\n</ol>\n</li>\n<li><code class=\"language-text\">.andDo()</code> 를 이용해 테스트 성공 후 수행할 행동을 명시한다.</li>\n<li><code class=\"language-text\">responseFields</code> 에 문서에 적힐 반환 형태와 설명을 명시한다.</li>\n</ol>\n<p>이때 어노테이션 중 <code class=\"language-text\">@WebMvcTest</code> 를 확인할 수 있는데, 처음에는 <code class=\"language-text\">@SpringBootTest</code> 어노테이션을 사용했었다. 하지만 여기서는 Controller에 대한 테스트만 수행할 예정이므로, 당연히 <code class=\"language-text\">@WebMvcTest</code> 를 사용하는 것으로 수정했다.</p>\n<p>간단한 구현 코드여서 테스트도 간단하게 성공했다. 이제 REST docs를 적용하러 가보자.</p>\n<h3>🏓 Spring REST Docs 적용</h3>\n<p>아래 참고를 보고, <code class=\"language-text\">build.gradle</code> 에 다음과 같이 코드를 추가했다.</p>\n<deckgo-highlight-code language=\"Groovy\" terminal=\"carbon\" theme=\"a11y-dark\" line-numbers=\"true\"  >\n          <code slot=\"code\">plugins {\n\tid &#39;org.springframework.boot&#39; version &#39;2.7.2&#39;\n\tid &#39;io.spring.dependency-management&#39; version &#39;1.0.12.RELEASE&#39;\n\tid &quot;org.asciidoctor.jvm.convert&quot; version &quot;3.3.2&quot;\n\tid &#39;java&#39;\n}\n\ngroup = &#39;com.example.QCA&#39;\nversion = &#39;0.0.1-SNAPSHOT&#39;\nsourceCompatibility = &#39;11&#39;\n\next {\n\tset(&#39;snippetsDir&#39;, file(&quot;build/generated-snippets&quot;))\n}\n\nconfigurations {\n\tasciidoctorExtensions\n\tcompileOnly {\n\t\textendsFrom annotationProcessor\n\t}\n}\n\nrepositories {\n\tmavenCentral()\n}\n\ndependencies {\n\timplementation &#39;org.springframework.boot:spring-boot-starter-data-jpa&#39;\n\timplementation &#39;org.springframework.boot:spring-boot-starter-web&#39;\n\timplementation &#39;org.springframework.boot:spring-boot-starter-validation&#39;\n\tcompileOnly &#39;org.projectlombok:lombok&#39;\n\tdevelopmentOnly &#39;org.springframework.boot:spring-boot-devtools&#39;\n\truntimeOnly &#39;mysql:mysql-connector-java&#39;\n\tannotationProcessor &#39;org.projectlombok:lombok&#39;\n\ttestImplementation &#39;org.springframework.boot:spring-boot-starter-test&#39;\n\n\t// Spring REST docs\n\ttestImplementation &#39;org.springframework.restdocs:spring-restdocs-mockmvc&#39;\n\tasciidoctorExtensions &#39;org.springframework.restdocs:spring-restdocs-asciidoctor&#39;\n}\n\ntest {\n\toutputs.dir snippetsDir\n\tuseJUnitPlatform()\n}\n\nasciidoctor { // asciidoctor 작업 구성\n\tdependsOn test // test 작업 이후에 작동하도록 하는 설정\n\tconfigurations &#39;asciidoctorExtensions&#39; // 위에서 작성한 configuration 적용\n\tinputs.dir snippetsDir // snippetsDir 를 입력으로 구성\n\n\t// source가 없으면 .adoc파일을 전부 html로 만들어버림\n\t// source 지정시 특정 adoc만 HTML로 만든다.\n\tsources{\n\t\tinclude(&quot;**/index.adoc&quot;,&quot;**/common/*.adoc&quot;)\n\t}\n\n\t// 특정 .adoc에 다른 adoc 파일을 가져와서(include) 사용하고 싶을 경우 경로를 baseDir로 맞춰주는 설정\n\t// 개별 adoc으로 운영한다면 필요 없는 옵션\n\tbaseDirFollowsSourceFile()\n}\n\n// static/docs 폴더 비우기\nasciidoctor.doFirst {\n\tdelete file(&#39;src/main/resources/static/docs&#39;)\n}\n\n// asccidoctor 작업 이후 생성된 HTML 파일을 static/docs 로 copy\ntask copyDocument(type: Copy) {\n\tdependsOn asciidoctor\n\tfrom file(&quot;build/docs/asciidoc&quot;)\n\tinto file(&quot;src/main/resources/static/docs&quot;)\n}\n\n// build 의 의존작업 명시\nbuild {\n\tdependsOn copyDocument\n}</code>\n        </deckgo-highlight-code>\n<p>gradle을 빌드한 후, 프로젝트를 빌드하면 <code class=\"language-text\">build/generated-snippets</code> 폴더에 아래와 같이 <code class=\"language-text\">snippets</code> 가 생성되는 것을 확인할 수 있다.</p>\n<span class='gatsby-resp-image-wrapper' style='position: relative; display: block; margin-left: auto; margin-right: auto; max-width: 490px; margin-bottom: 16px;'>\n      <a class='gatsby-resp-image-link' href='/static/67fa332cdcd964d4279f02d7eb8bcd03/ce5c5/restDocs.png' style='display: block' target='_blank' rel='noopener'>\n    <span class='gatsby-resp-image-background-image' style=\"padding-bottom: 150%; position: relative; bottom: 0; left: 0; background-image: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAAeCAYAAAAsEj5rAAAACXBIWXMAABYlAAAWJQFJUiTwAAADjklEQVRIx51Wy47aWBTkK2aVkSYKBmwDfmFswMbmTdM0TXen03koUaSssoiURRQpm+zmH0bzszWnLr60m4ZkkkXpXJvrcp1z6lxTMVpd5J0Ud/kSljeA0xmiFSSo2R3Um6FCef0zVBp+gpfZAv9++oLB+ALj5Q2idLEnOYw/JaxZAZ4J/hJU213Umh318G8rNGRzy+2jFWX44+MHRLdvMJ1fI19cY7q6hRMOYVj+/yfUCgjDdgUB6naIhtTWcmIVf1lhUx60OiPU3/+NZPMWSXam6vh7NZSNpqgwWhH+XL+DN97AlzSdMJNUpb4Nb5/yYW1PEtbbEXw3wefaFAMngS02on28aISgN4Er5MeIjt1ThA1nR/g9fIWb2S3SxRWG0w3SyQXy+ZVKnyr3tRblp0pR0QumHbgxzNKPbIiOptTZdnsw2zpGpxQGojBG1M3xz+gWLyZbjM5fYCIGp8nn6ztRusFgdI6J2Ggm1+Oznfmr5sPaEpWdip0SQ6Ufo1pYpZwe92kr7fZ39/fKqFhOD0TTHeBJuMLXdItv4xukZ8+RjNaYnd+JurVK1ZIB0Pstp1+g9wCiMAJhCoxWjKGXIgsyWNLZlj+AJ6WwhahqBqL2XjEjsVMa7VEp518XPOUm6ejSdNEOUnQK20TJHGF/iq5EWok1jAW21wf7UC/OgMojbwkcQWr7COKRepCeZFOIfr5COJihn63QEzQli3K3Dwh3KkkayFuZMlXSImyGglhGQdb8nfE0ofxQlegL8aWkzJRolZ7M9nB6iYk0iicQVWazLaZiryAeF7U8QlgrSA27uOYZafqqRkaxJjg19+uHU3NUoScKr01H1Wx+8VIp4ghSHSMNz7Hk9WT1XGqc7lU+IqTKhhBaRdfLI0Yv3o9lpH7T46n3PCI0JLaFcG25qsPJeC24UFZRnR2eqXuq0/m5Wrfku3RSIQmbQtiRurXl69eh9+RhdpRrEhFuN1MvoTfL1jmRcoiB+JBv5oOMnBgd3WKKSKjJThLqpnBS+PZczsZsdqlS45TwnCTYqJF8yA4/FcdtI9EuWeHQGnpN2+jT6ocKaewrsQ0Nvbx8rZTQ1Pl8q85Grnkm8nqxeYV4uDxBqAZ8R8w6GoV5aexqaV0+UPSp80PbuEK8lRp2k4UyMevHUWNk7XhP1U9qOl5eK5Nrvx4ltIXQp20Kq3hRvu9uU/5QMeprX76MjPoPwX8jcr/AQhdYOAAAAABJRU5ErkJggg=='); background-size: cover; display: block;\"></span>\n  <img class='gatsby-resp-image-image' alt='restDocs' title='restDocs' src='/static/67fa332cdcd964d4279f02d7eb8bcd03/ce5c5/restDocs.png' srcset='/static/67fa332cdcd964d4279f02d7eb8bcd03/e7570/restDocs.png 170w,\n/static/67fa332cdcd964d4279f02d7eb8bcd03/f46e7/restDocs.png 340w,\n/static/67fa332cdcd964d4279f02d7eb8bcd03/ce5c5/restDocs.png 490w' sizes='(max-width: 490px) 100vw, 490px' style='width:100%;height:100%;margin:0;vertical-align:middle;position:absolute;top:0;left:0;' loading='lazy' decoding='async'>\n  </a>\n    </span>\n<p>이제 만들어진 코드 조각을 이용해 문서를 만들 차례이다. 이를 위해 <code class=\"language-text\">main/resources/static/docs</code> 디렉토리를 만든다.</p>\n<ul>\n<li><code class=\"language-text\">gradle</code> 설정에 의해 이 디렉토리로 <code class=\"language-text\">html</code> 파일이 복사되어 옮겨진다.</li>\n</ul>\n<p>그리고 <code class=\"language-text\">src/docs/asciidoc</code> 디렉토리를 만들고 안에 <code class=\"language-text\">index.adoc</code> 파일을 생성한다.</p>\n<deckgo-highlight-code language=\"asciidoc\" terminal=\"carbon\" theme=\"a11y-dark\" line-numbers=\"true\"  >\n          <code slot=\"code\">= API 문서\n:doctype: book\n:icons: font\n// 문서에 표기되는 코드들의 하이라이팅\n:source-highlighter: highlightjs\n// toc (Table Of Contents) 위치 지정\n:toc: left \n:toclevels: 2\n:sectlinks:\n\n[[List-API]]\n== List API\n특정 정보 반환\n\n// 어떤 스니펫들을 사용할 것인지 명시\noperation::list-get[snippets=&#39;http-request,http-response,response-fields&#39;]</code>\n        </deckgo-highlight-code>\n<ul>\n<li><a href=\"https://narusas.github.io/2018/03/21/Asciidoc-basic.html\">Asciidocs문법</a>에서 더 자세한 사용법을 확인할 수 있다.</li>\n<li>이제 빌드를 하면, 아까 지정한 디렉토리에 <code class=\"language-text\">index.html</code> 이 만들어지고, 서버를 동작해 <code class=\"language-text\">../docs/index.html</code> 에서 확인할 수 있다.</li>\n</ul>\n<p>추가적인 최적화와 커스텀은 추후 수행할 예정이다.</p>\n<hr>\n<blockquote>\n<p>❗️ 구현 코드는 <a href=\"https://github.com/bsonCrew/QCA_Server\">Github</a>에서 확인할 수 있습니다 ....</p>\n</blockquote>\n<hr>\n<h2>⚽️ 참고</h2>\n<p>GCP 사용</p>\n<ul>\n<li><a href=\"https://spacek82.tistory.com/66\">[GCP]GCP 기초_Cloud SQL 만들기</a></li>\n<li><a href=\"https://coding-is-fun.tistory.com/10\">Spring Boot와 Google Cloud SQL연결 및 GCP(Google Cloud Platform) 서버 배포#2</a></li>\n</ul>\n<p>Spring REST Docs, MockMvc</p>\n<ul>\n<li><a href=\"https://young-bin.tistory.com/92\">Spring REST Docs 적용</a></li>\n<li><a href=\"https://ip99202.github.io/posts/%EC%8A%A4%ED%94%84%EB%A7%81-MockMvc-%ED%85%8C%EC%8A%A4%ED%8A%B8/\">스프링 MockMvc를 이용한 get, post, patch, delete 테스트</a></li>\n<li><a href=\"https://backtony.github.io/spring/2021-10-15-spring-test-3/#buildgradle-%EC%A0%84%EC%B2%B4-%EC%BD%94%EB%93%9C\">Spring REST Docs 적용 및 최적화 하기</a></li>\n</ul>","frontmatter":{"title":"🥊 2. GCP 배포와 Spring REST Docs 적용","date":"August 18, 2022","update":"August 18, 2022","tags":["Spring","MockMvc"],"series":"🥊 OpenSW"},"fields":{"slug":"/[OpenSW]2.GCP배포와SpringRESTDocs적용/","readingTime":{"minutes":10.01}}},"seriesList":{"edges":[{"node":{"id":"521f4c91-f6df-51aa-8126-fa72315ca2c4","fields":{"slug":"/[OpenSW]1.스프링이할일/"},"frontmatter":{"title":"🥊 1. 스프링이 할 일"}}},{"node":{"id":"e995a783-d49d-5bbf-8006-2417ec33eedb","fields":{"slug":"/[OpenSW]2.GCP배포와SpringRESTDocs적용/"},"frontmatter":{"title":"🥊 2. GCP 배포와 Spring REST Docs 적용"}}},{"node":{"id":"996f24a8-e034-554a-a982-276bb065f41e","fields":{"slug":"/[OpenSW]3.DB설계와HTTPS/"},"frontmatter":{"title":"🥊 3. DB 설계와 HTTPS"}}}]},"previous":{"fields":{"slug":"/[OS]MemoryManagement/"},"frontmatter":{"title":"🧩 Memory Management"}},"next":{"fields":{"slug":"/[OpenSW]3.DB설계와HTTPS/"},"frontmatter":{"title":"🥊 3. DB 설계와 HTTPS"}}},"pageContext":{"id":"e995a783-d49d-5bbf-8006-2417ec33eedb","series":"🥊 OpenSW","previousPostId":"fca20360-0d0d-58db-ab91-0f44ca0d0f00","nextPostId":"996f24a8-e034-554a-a982-276bb065f41e"}},"staticQueryHashes":[]}